<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>README.rst</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: gray; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic, pre.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
</a>
<div class="section" id="change-auto-installable-modules">
<h1>Change auto installable modules</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten.                   !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:162ad195483bc21079128fc8075e1cf29eba3e177cffd0fbfa8d42f28a27ceab
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/18.0/module_change_auto_install"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-module_change_auto_install"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>In odoo, by default some modules are marked as auto installable by the
<tt class="docutils literal">auto_install</tt> key present in the manifest.</p>
<ul class="simple">
<li>This feature is very useful for “glue” modules that allow two modules
to work together. (A typical example is <tt class="docutils literal">sale_stock</tt> which allows
<tt class="docutils literal">sale</tt> and <tt class="docutils literal">stock</tt> modules to work together).</li>
<li>However, Odoo SA also marks some modules as auto installable, even
though this is not technically required. This can happen for modules
the company wants to promote like <tt class="docutils literal">iap</tt>, modules with a big wow
effect like <tt class="docutils literal">partner_autocomplete</tt>, or some modules they consider
useful by default like <tt class="docutils literal">account_edi</tt>. See the discussion:
<a class="reference external" href="https://github.com/odoo/odoo/issues/71190">https://github.com/odoo/odoo/issues/71190</a></li>
</ul>
<p>This module allows to change by configuration, the list of auto
installable modules, adding or removing some modules to auto install.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="toc-entry-1">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
<li><a class="reference internal" href="#development" id="toc-entry-3">Development</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="installation">
<h2><a class="toc-backref" href="#toc-entry-1">Installation</a></h2>
<p>You don’t have to install this module. To make the features working :</p>
<ul class="simple">
<li>make the module <tt class="docutils literal">module_change_auto_install</tt> available in your
addons path</li>
<li>either update your <tt class="docutils literal">odoo.cfg</tt> or set the environment variables
following the “Configure” section</li>
</ul>
</div>
<div class="section" id="configuration">
<h2><a class="toc-backref" href="#toc-entry-2">Configuration</a></h2>
<ul class="simple">
<li>Edit your <tt class="docutils literal">odoo.cfg</tt> configuration file:</li>
<li>Add the module <tt class="docutils literal">module_change_auto_install</tt> in the
<tt class="docutils literal">server_wide_modules</tt> list.</li>
<li>(optional) Add a new entry <tt class="docutils literal">modules_auto_install_disabled</tt> to mark a
list of modules as NOT auto installable. The environment variable
<tt class="docutils literal">ODOO_MODULES_AUTO_INSTALL_DISABLED</tt> can also be set.</li>
<li>(optional) Add a new entry <tt class="docutils literal">modules_auto_install_enabled</tt> to mark a
list of modules as auto installable. This feature can be usefull for
companies that are hosting a lot of Odoo instances for many customers,
and want some modules to be always installed. The environment variable
<tt class="docutils literal">ODOO_MODULES_AUTO_INSTALL_ENABLED</tt> can also be set.</li>
</ul>
<p>The values in the configuration file takes precedence over the
environment variable values.</p>
<p><strong>Typical Settings</strong></p>
<pre class="code cfg literal-block">
<span class="na">server_wide_modules</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">web,module_change_auto_install</span><span class="w">

</span><span class="na">modules_auto_install_disabled</span><span class="w"> </span><span class="o">=</span><span class="w">
    </span><span class="na">partner_autocomplete,</span><span class="w">
    </span><span class="na">iap,</span><span class="w">
    </span><span class="na">mail_bot</span><span class="w">

</span><span class="na">modules_auto_install_enabled</span><span class="w"> </span><span class="o">=</span><span class="w">
    </span><span class="na">web_responsive</span><span class="o">:</span><span class="s">web,</span><span class="w">
    </span><span class="na">base_technical_features,</span><span class="w">
    </span><span class="na">disable_odoo_online,</span><span class="w">
    </span><span class="na">account_usability</span>
</pre>
<p>When using environment variables, the same configuration is:</p>
<pre class="code shell literal-block">
<span class="nb">export</span><span class="w"> </span><span class="nv">ODOO_MODULES_AUTO_INSTALL_DISABLED</span><span class="o">=</span>partner_autocomplete,iap,mail_bot<span class="w">
</span><span class="nb">export</span><span class="w"> </span><span class="nv">ODOO_MODULES_AUTO_INSTALL_ENABLED</span><span class="o">=</span>web_responsive:web,base_technical_features,disable_odoo_online,account_usability
</pre>
<p>Run your instance and check logs. Modules that has been altered should
be present in your log, at the load of your instance:</p>
<pre class="code shell literal-block">
INFO<span class="w"> </span>db_name<span class="w"> </span>odoo.addons.module_change_auto_install.patch:<span class="w"> </span>Module<span class="w"> </span><span class="s1">'iap'</span><span class="w"> </span>has<span class="w"> </span>been<span class="w"> </span>marked<span class="w"> </span>as<span class="w"> </span>NOT<span class="w"> </span>auto<span class="w"> </span>installable.<span class="w">
</span>INFO<span class="w"> </span>db_name<span class="w"> </span>odoo.addons.module_change_auto_install.patch:<span class="w"> </span>Module<span class="w"> </span><span class="s1">'mail_bot'</span><span class="w"> </span>has<span class="w"> </span>been<span class="w"> </span>marked<span class="w"> </span>as<span class="w"> </span>NOT<span class="w"> </span>auto<span class="w"> </span>installable.<span class="w">
</span>INFO<span class="w"> </span>db_name<span class="w"> </span>odoo.addons.module_change_auto_install.patch:<span class="w"> </span>Module<span class="w"> </span><span class="s1">'partner_autocomplete'</span><span class="w"> </span>has<span class="w"> </span>been<span class="w"> </span>marked<span class="w"> </span>as<span class="w"> </span>NOT<span class="w"> </span>auto<span class="w"> </span>installable.<span class="w">
</span>INFO<span class="w"> </span>db_name<span class="w"> </span>odoo.modules.loading:<span class="w"> </span><span class="m">42</span><span class="w"> </span>modules<span class="w"> </span>loaded<span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="m">0</span>.32s,<span class="w"> </span><span class="m">0</span><span class="w"> </span>queries<span class="w"> </span><span class="o">(</span>+0<span class="w"> </span>extra<span class="o">)</span>
</pre>
<p><strong>Advanced Configuration Possibilities</strong></p>
<p>if your <tt class="docutils literal">odoo.cfg</tt> file contains the following configuration:</p>
<pre class="code cfg literal-block">
<span class="na">modules_auto_install_enabled</span><span class="w"> </span><span class="o">=</span><span class="w">
    </span><span class="na">account_usability,</span><span class="w">
    </span><span class="na">web_responsive</span><span class="o">:</span><span class="s">web,</span><span class="w">
    </span><span class="na">base_technical_features</span><span class="o">:</span><span class="s">,</span><span class="w">
    </span><span class="na">point_of_sale</span><span class="o">:</span><span class="s">sale/purchase</span>
</pre>
<p>The behaviour will be the following:</p>
<ul class="simple">
<li><tt class="docutils literal">account_usability</tt> module will be installed as soon as all the
default dependencies are installed. (here <tt class="docutils literal">account</tt>)</li>
<li><tt class="docutils literal">web_responsive</tt> module will be installed as soon as <tt class="docutils literal">web</tt> is
installed. (Althought <tt class="docutils literal">web_responsive</tt> depends on <tt class="docutils literal">web</tt> and
<tt class="docutils literal">mail</tt>)</li>
<li><tt class="docutils literal">base_technical_features</tt> will be ALWAYS installed</li>
<li><tt class="docutils literal">point_of_sale</tt> module will be installed as soon as <tt class="docutils literal">sale</tt> and
<tt class="docutils literal">purchase</tt> module are installed.</li>
</ul>
<p>When using environment variables, the same configuration is:</p>
<pre class="code shell literal-block">
<span class="nb">export</span><span class="w"> </span><span class="nv">ODOO_MODULES_AUTO_INSTALL_ENABLED</span><span class="o">=</span>account_usability,web_responsive:web,base_technical_features:,point_of_sale:sale/purchase
</pre>
</div>
<div class="section" id="development">
<h2><a class="toc-backref" href="#toc-entry-3">Development</a></h2>
<p>If you upgrade your odoo Instance from a major version to another, using
the OCA Free Software project “OpenUpgrade”, you can also use this
module during the upgrade process, to avoid the installation of useless
new modules.</p>
</div>
<div class="section" id="bug-tracker">
<h2><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20module_change_auto_install%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h2><a class="toc-backref" href="#toc-entry-5">Credits</a></h2>
<div class="section" id="authors">
<h3><a class="toc-backref" href="#toc-entry-6">Authors</a></h3>
<ul class="simple">
<li>GRAP</li>
</ul>
</div>
<div class="section" id="contributors">
<h3><a class="toc-backref" href="#toc-entry-7">Contributors</a></h3>
<ul class="simple">
<li>Sylvain LE GAL &lt;<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>&gt;</li>
<li>XCG Consulting, part of <a class="reference external" href="https://orbeet.io/">Orbeet</a>:<ul>
<li>Vincent Hatakeyama &lt;<a class="reference external" href="mailto:vincent.hatakeyama&#64;xcg-consulting.fr">vincent.hatakeyama&#64;xcg-consulting.fr</a>&gt;</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="maintainers">
<h3><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org">
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
</a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external image-reference" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/18.0/module_change_auto_install">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
</div>
</div>
</body>
</html>
